Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial draft. #1

Merged
merged 4 commits into from
May 13, 2024
Merged

Initial draft. #1

merged 4 commits into from
May 13, 2024

Conversation

tribeiro
Copy link
Contributor

@tribeiro tribeiro commented May 9, 2024

No description provided.

@tribeiro tribeiro requested a review from b1quint May 9, 2024 21:38
index.rst Outdated
@@ -4,9 +4,93 @@ Night Planning Tool

.. abstract::

This technote describes the design of an integrated night planning tool. This is a tools that allows our team to collect a group of Jira tickets that describes a set of tests, allows us to organize these into a coherent list of tests to execute, that can later be loaded and executed at the summit.
This technote describes the design of an integrated night planning tool.
This is a tools that allows our team to collect a group of Jira tickets describing a set of tests/observations, allows us to organize these into a coherent list that can later be loaded and executed at the summit.
Copy link

@b1quint b1quint May 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo

"This is a tool that allows ..."

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... "tests/observations, allows us to organize" ...

Consider splitting the sentence here.

index.rst Outdated

- SITCOM are used to capture high level tests/verification activities.
They are usually connected to one or more requirement or some other commissioning activity.
For example, SITCOM-1099 was created to capture the tests required to validate the operation of the system with the TMA dynamic settings going from 5% all the way to 100% of its requirements.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weak suggestion - convert SITCOM-1099 into a link.

- BLOCK tickets are used to design, plan, execute and track activities at the summit.
Usually a BLOCK ticket will be linked to a SITCOM ticket.

Up to now, planning activities at the summit have revolved around collecting the BLOCK tickets that will be executed at night and sorting them out in a table with some information about priority and order of execution.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a link to one of the night plans/logs for a practical example? Here is one for convenience:
https://confluence.lsstcorp.org/display/LSSTCOM/2024-04-23+Simonyi+Night+Log


We will adopt Jira's Zephyr application to create test cases, test cycles and test plans to organize how tests will be executed and planned.

- BLOCK tickets will be used to describe what the block does, link it to a particular SITCOM ticket and will also aggregate the block configuration.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we adopt Zephyr, I recommend that we limit BLOCK tickets for those who will have JSON files or scheduler configurations. I don't see why we need to create a BLOCK ticket and a test case if that does not favor automatization/scripting.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this. For example, see the doc page that Erik is working on describing the BLOCK project workflow. I think there is some value to having a BLOCK ticket. However, this might be a good discussion to have with the rest of the team.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have a couple of examples here? I believe, the way this is now, it is too abstract for a discussion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Erik's document would be a better place for this information. I am going to link Erik's document here and will add an item in the FAQ to talk about this.


- BLOCK tickets will be used to describe what the block does, link it to a particular SITCOM ticket and will also aggregate the block configuration.

- Test Cases will have a step by step description of how to execute a particular BLOCK.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Including instructions to setup/wrap-up.


- Test Cycles will be used to plan a particular night.
They contain a list of Test Cases, ordered in the same way they should be executed.
The Environment field is used to separate the Test Cases that will be executed at different parts of the day; Daytime, Afternoon, Early Night, Late Night, etc.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The time periods are something that I would like to agree on and have it set in stone.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree... let's discuss that in the next meeting.

@b1quint b1quint self-requested a review May 13, 2024 18:30
Copy link

@b1quint b1quint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we are good now.

@tribeiro tribeiro merged commit 685363c into main May 13, 2024
2 checks passed
@tribeiro tribeiro deleted the tickets/DM-44231 branch May 13, 2024 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants